Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve telemetry documentation #3962

Merged
merged 12 commits into from
Oct 17, 2023
Merged

Improve telemetry documentation #3962

merged 12 commits into from
Oct 17, 2023

Conversation

BrynCooke
Copy link
Contributor

Improve metrics and tracing docs

  1. Deprecate Jaeger native.
  2. Improve OTLP docs.
  3. Add specific documentation for Datadog via OTLP

Part of #3226

Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩

@BrynCooke BrynCooke requested a review from a team as a code owner October 3, 2023 16:25
@router-perf
Copy link

router-perf bot commented Oct 3, 2023

CI performance tests

  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • large-request - Stress test with a 1 MB request payload
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • reload - Reload test over a long period of time at a constant rate of users
  • no-graphos - Basic stress test, no GraphOS.
  • xxlarge-request - Stress test with 100 MB request payload
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • const - Basic stress test that runs with a constant number of users

@BrynCooke BrynCooke requested review from shorgi and garypen October 3, 2023 16:25
@BrynCooke BrynCooke mentioned this pull request Oct 3, 2023
Open
28 tasks
Base automatically changed from bryn/telemetry-enabled-field to dev October 3, 2023 16:32
Improve metrics and tracing docs
80ac895 
1. Deprecate Jaeger native.
2. Improve OTLP docs.
3. Add specific documentation for Datadog via OTLP.
@BrynCooke BrynCooke force-pushed the bryn/deprecate-jaeger branch from e957871 to 80ac895 Compare October 3, 2023 16:33
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

@BrynCooke, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@BrynCooke BrynCooke linked an issue Oct 3, 2023 that may be closed by this pull request
Document the proper way to send traces, metrics and logs to Datadog #2604
Open
shorgi
shorgi reviewed Oct 3, 2023
View reviewed changes
docs/source/configuration/metrics.mdx Outdated Show resolved Hide resolved
docs/source/configuration/metrics.mdx Outdated Show resolved Hide resolved
docs/source/configuration/tracing.mdx Outdated Show resolved Hide resolved
docs/source/configuration/tracing.mdx Outdated Show resolved Hide resolved
@BrynCooke BrynCooke requested review from a team, lrlna and o0Ignition0o October 4, 2023 09:07
garypen
garypen reviewed Oct 4, 2023
View reviewed changes
Copy link
Contributor

@garypen garypen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think my comment about endpoint applies to all of these changes. I'm not sure if we should be documenting how to set things up for a realistic production environment or (as we often do in our docs) for a standalone development environment.

Maybe we should do both and make the difference clear?

docs/source/configuration/metrics.mdx Outdated Show resolved Hide resolved
docs/source/configuration/metrics.mdx Outdated Show resolved Hide resolved
@BrynCooke BrynCooke requested a review from garypen October 6, 2023 11:19
@BrynCooke BrynCooke force-pushed the bryn/deprecate-jaeger branch from efc136f to aa7cd48 Compare October 6, 2023 12:13
garypen
garypen reviewed Oct 12, 2023
View reviewed changes
Copy link
Contributor

@garypen garypen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question.

docs/source/configuration/tracing.mdx Outdated Show resolved Hide resolved
Remove callout to env expansion, as this can be applied to all config…
bc6d6d2 
…uration and makes no sense to just call out at this particular place.
@BrynCooke BrynCooke requested a review from garypen October 12, 2023 09:36
@BrynCooke BrynCooke enabled auto-merge (squash) October 17, 2023 09:08
@BrynCooke BrynCooke merged commit 42ffc28 into dev Oct 17, 2023
2 checks passed
@BrynCooke BrynCooke deleted the bryn/deprecate-jaeger branch October 17, 2023 09:09
@oliverjumpertz oliverjumpertz mentioned this pull request Nov 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shorgi shorgi shorgi left review comments

@garypen garypen garypen approved these changes

@lrlna lrlna Awaiting requested review from lrlna lrlna was automatically assigned from apollographql/router

@o0Ignition0o o0Ignition0o Awaiting requested review from o0Ignition0o o0Ignition0o was automatically assigned from apollographql/router

Assignees

@BrynCooke BrynCooke

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the proper way to send traces, metrics and logs to Datadog
3 participants
@BrynCooke @garypen @shorgi